ArcPad Configuration File Schema
ArcPad Element
See Also  Send comments on this topic.
ArcPad Configuration File Schema : ArcPad Element

Glossary Item Box

Description

The root element for all ArcPad XML statements.

Diagram

SCRIPT Element CONFIG Element Sequence ArcPad Element

Overview

ArcPad
The root element for all ArcPad XML statements.
debug optional Restriction of xs:string
Sequence
CONFIG
Used in ArcPad.apx to define a custom ArcPad default configuration. ArcPad.apx must be located in the ArcPad application directory and is automatically loaded when ArcPad starts.
Sequence
FORMS
The parent element for defining an ArcPad form.
Sequence
FORM
Used to define an ArcPad form.
GPSCURSOR
Used in default configuration (ArcPad.apx) to specify an alternate set of GPS cursors.
image required xs:string
transparencycolor optional xs:string
Transparency color of the image.
STATUSBAR
Used to define display properties for the status bar.
SYSTEMOBJECTS
Used in applet (*.apa) files, default configuration (ArcPad.apx) files, and layer definitions to associate scripts with ArcPad system object events.
Sequence
APPLICATION
Used to specify scripts to call when Application object events occur.
AUX
The parent element for AUX port settings in ArcPadPrefs.apx. Used to specify script subroutines to call when AUX events occur.
GPS
Used to specify GPS preferences and script subroutines to call when GPS events occur.
onaveragestart optional xs:string
Specify the script to run when this event occurs.
onaveragestop optional xs:string
Specify the script to run when this event occurs.
onclose optional xs:string
Specify the script to run when this event occurs
onexevent optional xs:string
Specify the script to run when this event occurs.
onopen optional xs:string
Specify the script to run when this event occurs
onposition optional xs:string
Specify the script to run when this event occurs.
onsentence optional xs:string
Specify the script to run when this event occurs.
MAP
When parent element is SYSTEMOBJECTS, MAP is used to specify scripts to call when Map object events occur.
onafterdraw optional xs:string
Specify the script to run when this event occurs.
onafterlayerdraw optional xs:string
Specify the script to run when this event occurs.
onbeforedraw optional xs:string
Specify the script to run when this event occurs.
onbeforelayerdraw optional xs:string
Specify the script to run when this event occurs.
onclose optional xs:string
Specify the script to run when this event occurs
ondrawingcancelled optional xs:string
Specify the script to run when this event occurs.
onfeatureadded optional xs:string
Specify the script to run when this event occurs.
onfeaturechanged optional xs:string
Specify the script to run when this event occurs.
onfeaturedeleted optional xs:string
Specify the script to run when this event occurs.
onfeaturegeometrychanged optional xs:string
Specify the script to run when this event occurs.
onidentify optional xs:string
Specify the script to run when this event occurs.
onnew optional xs:string
Specify the script to run when this event occurs.
onopen optional xs:string
Specify the script to run when this event occurs
onpointerdown optional xs:string
Specify the script to run when this event occurs.
onpointermodechanged optional
Specify the script to run when this event occurs.
onpointermove optional xs:string
Specify the script to run when this event occurs.
onpointerup optional xs:string
Specify the script to run when this event occurs.
onsave optional xs:string
Specify the script to run when this event occurs.
onselectionchanged optional xs:string
Specify the script to run when this event occurs.
NAVIGATION
Used to specify scripts to call when Navigation object events occur.
RANGEFINDER
Used to specify Rangefinder preferences and script subroutines to call when Rangefinder events occur.
onclose optional xs:string
Specify the script to run when this event occurs
onexevent optional xs:string
Specify the script to run when this event occurs.
onmeasurement optional xs:string
Specify the script to run when this event occurs.
onopen optional xs:string
Specify the script to run when this event occurs
TOOLBARS
The pareent element for all ArcPad toolbars.
Sequence
TOOLBAR 1..∞
Used to define a toolbar in an applet file (*.apa) or custom configuration file (ArcPad.apx).
buttonsize optional Restriction of xs:int
Specifies the scale factor for the size of toolbar buttons on this toolbar. For example, a value of 2 makes toolbar buttons twice as large as the standard size (16X16). This setting overrides the buttonsize attribute in the DISPLAY element (in ArcPadPrefs.apx).
caption optional xs:string
image optional xs:string
name optional xs:string
visible optional Restriction of xs:string
Sequence
SEPARATOR 1..∞
Used to specify a separator between tools in a custom toolbar.
TOOLBUTTON 1..∞
Used to define a custom toolbutton or specify a built-in toolbutton in a toolbar.
command optional xs:string
image optional xs:string
name optional xs:string
shortcut optional xs:string
onclick optional xs:string
Specify the script to run when this event occurs.
onpointerdown optional xs:string
Specify the script to run when this event occurs.
onpointermove optional xs:string
Specify the script to run when this event occurs.
onpointerup optional xs:string
Specify the script to run when this event occurs.
prompt optional xs:string
tooltip optional xs:string
Sequence
MENUITEM 1..∞
Used to define a custom toolbutton or specify a built-in toolbutton in a pull-down menu.
caption optional xs:string
command optional xs:string
image optional xs:string
name optional xs:string
onclick optional xs:string
Specify the script to run when this event occurs.
onpointerdown optional xs:string
Specify the script to run when this event occurs.
onpointermove optional xs:string
Specify the script to run when this event occurs.
onpointerup optional xs:string
Specify the script to run when this event occurs.
promote optional Restriction of xs:string
prompt optional xs:string
shortcut optional xs:string
backgroundcolor optional xs:string
horizalignment optional Restriction of xs:string
style optional Restriction of xs:int
tintcolor optional xs:string
transparency optional xs:double
Sequence
TOOLBUTTON 1..8
command optional xs:string
useonce optional Restriction of xs:string
flip optional Restriction of xs:string
SCRIPT
Used in customization files (ArcPad.apx, *.apa, *.apl) to define scripts or specify an associated script file.

Attributes

NameTypeUseDefaultFixedDescription
debugRestriction of xs:stringoptionalfalse  

Examples

Source

<xs:element name="ArcPad" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>The root element for all ArcPad XML statements.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element name="CONFIG">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="FORMS">
              <xs:complexType>
                <xs:sequence>
                  <xs:element ref="FORM" />
                </xs:sequence>
              </xs:complexType>
            </xs:element>
            <xs:element name="GPSCURSOR">
              <xs:annotation>
                <xs:documentation>Used in default configuration (ArcPad.apx) to specify an alternate set of GPS cursors.</xs:documentation>
              </xs:annotation>
              <xs:complexType>
                <xs:attribute use="required" ref="image">
                  <xs:annotation>
                    <xs:documentation>The bitmap that contains the GPS cursor images.</xs:documentation>
                  </xs:annotation>
                </xs:attribute>
                <xs:attribute name="transparencycolor" default="Magenta" type="xs:string">
                  <xs:annotation>
                    <xs:documentation>Transparency color of the image.</xs:documentation>
                  </xs:annotation>
                </xs:attribute>
              </xs:complexType>
            </xs:element>
            <xs:element ref="STATUSBAR">
              <xs:annotation>
                <xs:documentation>Used to define display properties for the status bar.</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="SYSTEMOBJECTS">
              <xs:complexType>
                <xs:sequence>
                  <xs:element ref="APPLICATION" />
                  <xs:element ref="AUX" />
                  <xs:element name="GPS">
                    <xs:complexType>
                      <xs:attribute ref="onaveragestart" />
                      <xs:attribute ref="onaveragestop" />
                      <xs:attribute ref="onclose" />
                      <xs:attribute ref="onexevent" />
                      <xs:attribute ref="onopen" />
                      <xs:attribute ref="onposition" />
                      <xs:attribute ref="onsentence" />
                    </xs:complexType>
                  </xs:element>
                  <xs:element name="MAP">
                    <xs:complexType>
                      <xs:attribute ref="onafterdraw" />
                      <xs:attribute ref="onafterlayerdraw" />
                      <xs:attribute ref="onbeforedraw" />
                      <xs:attribute ref="onbeforelayerdraw" />
                      <xs:attribute ref="onclose" />
                      <xs:attribute ref="ondrawingcancelled" />
                      <xs:attribute ref="onfeatureadded" />
                      <xs:attribute ref="onfeaturechanged" />
                      <xs:attribute ref="onfeaturedeleted" />
                      <xs:attribute ref="onfeaturegeometrychanged" />
                      <xs:attribute ref="onidentify" />
                      <xs:attribute ref="onnew" />
                      <xs:attribute ref="onopen" />
                      <xs:attribute ref="onpointerdown" />
                      <xs:attribute ref="onpointermodechanged" />
                      <xs:attribute ref="onpointermove" />
                      <xs:attribute ref="onpointerup" />
                      <xs:attribute ref="onsave" />
                      <xs:attribute ref="onselectionchanged" />
                    </xs:complexType>
                  </xs:element>
                  <xs:element ref="NAVIGATION" />
                  <xs:element name="RANGEFINDER">
                    <xs:complexType>
                      <xs:attribute ref="onclose" />
                      <xs:attribute ref="onexevent" />
                      <xs:attribute ref="onmeasurement" />
                      <xs:attribute ref="onopen" />
                    </xs:complexType>
                  </xs:element>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
            <xs:element name="TOOLBARS">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="TOOLBAR" maxOccurs="unbounded">
                    <xs:complexType>
                      <xs:sequence>
                        <xs:element maxOccurs="unbounded" name="SEPARATOR">
                          <xs:complexType />
                        </xs:element>
                        <xs:element name="TOOLBUTTON" maxOccurs="unbounded">
                          <xs:complexType>
                            <xs:sequence>
                              <xs:element name="MENUITEM" maxOccurs="unbounded">
                                <xs:complexType>
                                  <xs:attribute ref="caption" />
                                  <xs:attribute ref="command" />
                                  <xs:attribute ref="image" />
                                  <xs:attribute ref="name" />
                                  <xs:attribute ref="onclick" />
                                  <xs:attribute ref="onpointerdown" />
                                  <xs:attribute ref="onpointermove" />
                                  <xs:attribute ref="onpointerup" />
                                  <xs:attribute default="false" name="promote">
                                    <xs:simpleType>
                                      <xs:restriction base="xs:string">
                                        <xs:enumeration value="true" />
                                        <xs:enumeration value="false" />
                                      </xs:restriction>
                                    </xs:simpleType>
                                  </xs:attribute>
                                  <xs:attribute ref="prompt" />
                                  <xs:attribute ref="shortcut" />
                                </xs:complexType>
                              </xs:element>
                            </xs:sequence>
                            <xs:attribute ref="command" />
                            <xs:attribute ref="image" />
                            <xs:attribute ref="name" />
                            <xs:attribute ref="shortcut" />
                            <xs:attribute ref="onclick" />
                            <xs:attribute ref="onpointerdown" />
                            <xs:attribute ref="onpointermove" />
                            <xs:attribute ref="onpointerup" />
                            <xs:attribute ref="prompt" />
                            <xs:attribute ref="tooltip" />
                          </xs:complexType>
                        </xs:element>
                      </xs:sequence>
                      <xs:attribute ref="buttonsize" />
                      <xs:attribute ref="caption" />
                      <xs:attribute ref="image" />
                      <xs:attribute ref="name" />
                      <xs:attribute ref="visible" />
                    </xs:complexType>
                  </xs:element>
                  <xs:element maxOccurs="1" name="MAPNAVIGATOR">
                    <xs:complexType>
                      <xs:sequence>
                        <xs:element maxOccurs="8" name="TOOLBUTTON">
                          <xs:complexType>
                            <xs:attribute ref="command" />
                            <xs:attribute default="true" name="useonce">
                              <xs:simpleType>
                                <xs:restriction base="xs:string">
                                  <xs:enumeration value="true" />
                                  <xs:enumeration value="false" />
                                </xs:restriction>
                              </xs:simpleType>
                            </xs:attribute>
                            <xs:attribute default="true" name="flip">
                              <xs:simpleType>
                                <xs:restriction base="xs:string">
                                  <xs:enumeration value="true" />
                                  <xs:enumeration value="false" />
                                </xs:restriction>
                              </xs:simpleType>
                            </xs:attribute>
                          </xs:complexType>
                        </xs:element>
                      </xs:sequence>
                      <xs:attribute default="SteelBlue" ref="backgroundcolor" />
                      <xs:attribute ref="horizalignment" />
                      <xs:attribute default="0" name="style">
                        <xs:simpleType>
                          <xs:restriction base="xs:int">
                            <xs:minInclusive value="0" />
                            <xs:maxInclusive value="3" />
                            <xs:pattern value="[\-+]?[0-9]+" />
                          </xs:restriction>
                        </xs:simpleType>
                      </xs:attribute>
                      <xs:attribute default="0,20,40" name="tintcolor" type="xs:string" />
                      <xs:attribute default="0.0" ref="transparency" />
                    </xs:complexType>
                  </xs:element>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element ref="SCRIPT" />
    </xs:sequence>
    <xs:attribute default="false" name="debug">
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
</xs:element>

See Also

© 2012 All Rights Reserved.